Remove User from Group
AutomatR.AWS.RemoveUserFromGroup
The "Remove User From Group" activity in AutomatR is part of the AWS IAM (Identity and Access Management) Group activities package, enabling automation processes to remove a specified user from a group within AWS IAM. This activity streamlines user management tasks, enhancing the efficiency of automation workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Access Key ID | Provides the encrypted access key ID for your AWS account, enabling connection to the AWS IAM service. String variables containing the access key ID. |
| Secret Access Key | Provides the encrypted secret access key for your AWS account, enabling connection to the AWS IAM service. String variables containing the secret access key. |
| Region | Specifies the region in which the IAM group is located from which you want to remove a user. Use the RegionEndpoint enumeration to set the region. |
| User Name | Specifies the username of the user that you want to remove from the group. String variables containing the username. |
| Group Name | Specifies the name of the group from which the user should be removed. String variables containing the group name. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variable or argument containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Remove User From Group" activity. Useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the wait time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Result | Outputs the result of the "Remove User From Group" operation, indicating whether the user was successfully removed from the group or any encountered errors. Variables of relevant types (e.g., Boolean variables) to store the operation result. |
How to use:
- Drag and drop the "Remove User From Group" activity onto the workflow.
- Configure the properties by providing the required inputs, such as access key ID, secret access key, region, username, and group name.
- Optionally, configure the delay and customize the display name.
- Execute the workflow to remove the specified user from the group.
Example: Consider an example where the "Remove User From Group" activity is used to remove a user named "JohnDoe" from a group named "Developers" in the "us-east-1" region:
Remove User From Group:
Display Name: "Remove JohnDoe From Developers"
Access Key ID: "**************"
Secret Access Key: "**************"
Region: "us-east-1"
User Name: "JohnDoe"
Group Name: "Developers"
Result: isUserRemoved
In this example, the activity removes the user "JohnDoe" from the "Developers" group in the "us-east-1" region. The result of the operation (success or failure) is stored in the Boolean variable "isUserRemoved" for further handling in the workflow.